C:/Data/Projects/maerz2006/tns2/impl/TNSRemoteInterfaceDLL/TNSRemoteInterfaceDLL.cpp File Reference

Classes
class	RI_DataLock
Defines
#define	DLLTNSRI_EXPORTS
#define	SUPRESS_UNUSED_WARNING(var)   (void)(var)
#define	READDATA_FUNCTIONDEFINITION(PROCESSNAME, MUTEX)
#define	WRITEDATA_FUNCTIONDEFINITION(PROCESSNAME, MUTEX)
#define	READWRITEDATA_FUNCTIONDEFINITIONS(PROCESSNAME, MUTEX)
Functions
BOOL APIENTRY	DllMain (HANDLE hModule, DWORD ul_reason_for_call, LPVOID lpReserved)
BOOL	RI_RegisterTNS (HWND tns)
BOOL	RI_UnregisterTNS ()
HWND	RI_GetTNS ()
	Get the message receiver handle of the navigation software.
unsigned long	RI_GetDLLVersion ()
	Get the version number of the dll.
template<class T>
LRESULT	WriteData (LPARAM id, T &shared, T const &source, HANDLE lock)
template<class T>
LRESULT	ReadData (LPARAM id, T &target, T const &shared, HANDLE lock)
Variables
HWND	h_TNS = NULL
RI_CLinkMercartor2Map	ri_CLinkMercartor2Map = {0}
RI_CSearchAddress	ri_CSearchAddress = {0}
RI_CAddStopOffPoint	ri_CAddStopOffPoint = {0}
RI_CAddStopOffPoint2FavoriteList	ri_CAddStopOffPoint2FavoriteList = {0}
RI_CAddStopOffPoint2PreviousDestinationList	ri_CAddStopOffPoint2PreviousDestinationList = {0}
RI_CGetStopOffPointList	ri_CGetStopOffPointList = {0}
RI_CClearStopOffPoint	ri_CClearStopOffPoint = {0}
RI_CGetFavoriteList	ri_CGetFavoriteList = {0}
RI_CClearStopOffPointFromFavoriteList	ri_CClearStopOffPointFromFavoriteList = {0}
RI_CGetPreviousDestinationList	ri_CGetPreviousDestinationList = {0}
RI_CClearStopOffPointFromPreviousDestinationList	ri_CClearStopOffPointFromPreviousDestinationList = {0}
RI_CActualApplicationState	ri_CActualApplicationState = {0}
RI_CSystemInfo	ri_CSystemInfo = {0}
RI_CSwitchMap	ri_CSwitchMap = {0}
RI_CChangeApplicationOptions	ri_CChangeApplicationOptions = {0}
RI_CStartGPSRecord	ri_CStartGPSRecord = {0}
RI_CStopGPSRecord	ri_CStopGPSRecord = {0}
RI_CShowMessage	ri_CShowMessage = {0}
RI_CRoutePlanning	ri_CRoutePlanning = {0}
RI_CInverseGeoGoding	ri_CInverseGeoGoding = {0}
RI_CGPSInfo	ri_CGPSInfo = {0}
HANDLE	m_SharedMemoryLock
HANDLE	m_GPSMemoryLock
const unsigned long	m_RI_DLLVersion = m_RI_DLLHeaderVersion

---

Define Documentation

#define DLLTNSRI_EXPORTS

#define READDATA_FUNCTIONDEFINITION (  PROCESSNAME, MUTEX   )

Value: DLLTNSRI_API LRESULT RI_##PROCESSNAME##_ReadData( LPARAM id, RI_C##PROCESSNAME & data ) \ { \ return ReadData( id, data, ri_C##PROCESSNAME, MUTEX ); \ }

#define READWRITEDATA_FUNCTIONDEFINITIONS (  PROCESSNAME, MUTEX   )

Value: READDATA_FUNCTIONDEFINITION( PROCESSNAME, MUTEX ) \ WRITEDATA_FUNCTIONDEFINITION( PROCESSNAME, MUTEX )

#define SUPRESS_UNUSED_WARNING (  var   )     (void)(var)

Used to supress warnings like "declared but not used".

#define WRITEDATA_FUNCTIONDEFINITION (  PROCESSNAME, MUTEX   )

Value: DLLTNSRI_API LRESULT RI_##PROCESSNAME##_WriteData( LPARAM id, RI_C##PROCESSNAME & data ) \ { \ return WriteData( id, ri_C##PROCESSNAME, data, MUTEX ); \ }

---

Function Documentation

BOOL APIENTRY DllMain (  HANDLE  hModule, DWORD  ul_reason_for_call, LPVOID  lpReserved )

template<class T> LRESULT ReadData (  LPARAM  id, T &  target, T const &  shared, HANDLE  lock )

Reading data from the shared memoy. Parameters: id  Process ID which is compared with the data ID. If they do not match the function returns RI_NOTFOUND target  Target structure shared  Source structure in the shared memory. lock  A mutex must be passed for locking Returns: RI_NOERROR indicates sucess ;)

BOOL RI_RegisterTNS (  HWND  tns  )

BOOL RI_UnregisterTNS (   )

template<class T> LRESULT WriteData (  LPARAM  id, T &  shared, T const &  source, HANDLE  lock )

Writing data in the shared memory Parameters: id  An id is written inside the data structure. It is used to check if data belongs to a process shared  Target structure in the shared memory. source  Source to be copied lock  A mutex must be passed for locking Returns: RI_NOERROR indicates sucess ;)

---

Variable Documentation

HWND h_TNS = NULL

HANDLE m_GPSMemoryLock

const unsigned long m_RI_DLLVersion = m_RI_DLLHeaderVersion

HANDLE m_SharedMemoryLock

RI_CActualApplicationState ri_CActualApplicationState = {0}

RI_CAddStopOffPoint ri_CAddStopOffPoint = {0}

RI_CAddStopOffPoint2FavoriteList ri_CAddStopOffPoint2FavoriteList = {0}

RI_CAddStopOffPoint2PreviousDestinationList ri_CAddStopOffPoint2PreviousDestinationList = {0}

RI_CChangeApplicationOptions ri_CChangeApplicationOptions = {0}

RI_CClearStopOffPoint ri_CClearStopOffPoint = {0}

RI_CClearStopOffPointFromFavoriteList ri_CClearStopOffPointFromFavoriteList = {0}

RI_CClearStopOffPointFromPreviousDestinationList ri_CClearStopOffPointFromPreviousDestinationList = {0}

RI_CGetFavoriteList ri_CGetFavoriteList = {0}

RI_CGetPreviousDestinationList ri_CGetPreviousDestinationList = {0}

RI_CGetStopOffPointList ri_CGetStopOffPointList = {0}

RI_CGPSInfo ri_CGPSInfo = {0}

RI_CInverseGeoGoding ri_CInverseGeoGoding = {0}

RI_CLinkMercartor2Map ri_CLinkMercartor2Map = {0}

RI_CRoutePlanning ri_CRoutePlanning = {0}

RI_CSearchAddress ri_CSearchAddress = {0}

RI_CShowMessage ri_CShowMessage = {0}

RI_CStartGPSRecord ri_CStartGPSRecord = {0}

RI_CStopGPSRecord ri_CStopGPSRecord = {0}

RI_CSwitchMap ri_CSwitchMap = {0}

RI_CSystemInfo ri_CSystemInfo = {0}

---